<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>file_base</title>
    <link rel="stylesheet" href="../../boostbook.css" type="text/css">
    <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
    <link rel="home" href="../../index.html" title="Asio">
    <link rel="up" href="../reference.html" title="Reference">
    <link rel="prev" href="experimental__wait_for_one_success/wait_for_one_success.html"
          title="experimental::wait_for_one_success::wait_for_one_success">
    <link rel="next" href="file_base/append.html" title="file_base::append">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
    <tr>
        <td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="experimental__wait_for_one_success/wait_for_one_success.html"><img src="../../prev.png"
                                                                                              alt="Prev"></a><a
        accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h"
                                                                                       href="../../index.html"><img
        src="../../home.png" alt="Home"></a><a accesskey="n" href="file_base/append.html"><img src="../../next.png"
                                                                                               alt="Next"></a>
</div>
<div class="section">
    <div class="titlepage">
        <div>
            <div><h3 class="title">
                <a name="asio.reference.file_base"></a><a class="link" href="file_base.html"
                                                          title="file_base">file_base</a>
            </h3></div>
        </div>
    </div>
    <p>
        <a class="indexterm" name="asio.indexterm.file_base"></a>
    </p>
    <p>
        The <a class="link" href="file_base.html" title="file_base"><code class="computeroutput"><span
            class="identifier">file_base</span></code></a>
        class is used as a base for the <a class="link" href="basic_stream_file.html" title="basic_stream_file"><code
            class="computeroutput"><span class="identifier">basic_stream_file</span></code></a> and <a class="link"
                                                                                                       href="basic_random_access_file.html"
                                                                                                       title="basic_random_access_file"><code
            class="computeroutput"><span class="identifier">basic_random_access_file</span></code></a> class templates
        so that we have a common place to define flags.
    </p>
    <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">file_base</span>
</pre>
    <h5>
        <a name="asio.reference.file_base.h0"></a>
        <span><a name="asio.reference.file_base.types"></a></span><a class="link"
                                                                     href="file_base.html#asio.reference.file_base.types">Types</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="file_base/flags.html" title="file_base::flags"><span class="bold"><strong>flags</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        A bitmask type (C++ Std [lib.bitmask.types]).
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="file_base/seek_basis.html" title="file_base::seek_basis"><span
                                class="bold"><strong>seek_basis</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Basis for seeking in a file.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <h5>
        <a name="asio.reference.file_base.h1"></a>
        <span><a name="asio.reference.file_base.protected_member_functions"></a></span><a class="link"
                                                                                          href="file_base.html#asio.reference.file_base.protected_member_functions">Protected
        Member Functions</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="file_base/_file_base.html" title="file_base::~file_base"><span
                                class="bold"><strong>~file_base</strong></span></a>
                        <span class="silver">[destructor]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Protected destructor to prevent deletion through this type.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <h5>
        <a name="asio.reference.file_base.h2"></a>
        <span><a name="asio.reference.file_base.data_members"></a></span><a class="link"
                                                                            href="file_base.html#asio.reference.file_base.data_members">Data
        Members</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="file_base/append.html" title="file_base::append"><span
                                class="bold"><strong>append</strong></span></a>
                        <span class="silver">[static]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Open the file in append mode.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="file_base/create.html" title="file_base::create"><span
                                class="bold"><strong>create</strong></span></a>
                        <span class="silver">[static]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Create the file if it does not exist.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="file_base/exclusive.html" title="file_base::exclusive"><span class="bold"><strong>exclusive</strong></span></a>
                        <span class="silver">[static]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Ensure a new file is created. Must be combined with create.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="file_base/read_only.html" title="file_base::read_only"><span class="bold"><strong>read_only</strong></span></a>
                        <span class="silver">[static]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Open the file for reading.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="file_base/read_write.html" title="file_base::read_write"><span
                                class="bold"><strong>read_write</strong></span></a>
                        <span class="silver">[static]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Open the file for reading and writing.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="file_base/sync_all_on_write.html"
                           title="file_base::sync_all_on_write"><span
                                class="bold"><strong>sync_all_on_write</strong></span></a> <span
                            class="silver">[static]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Open the file so that write operations automatically synchronise
                        the file data and metadata to disk.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="file_base/truncate.html" title="file_base::truncate"><span
                                class="bold"><strong>truncate</strong></span></a>
                        <span class="silver">[static]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Open the file with any existing contents truncated.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="file_base/write_only.html" title="file_base::write_only"><span
                                class="bold"><strong>write_only</strong></span></a>
                        <span class="silver">[static]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Open the file for writing.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <h5>
        <a name="asio.reference.file_base.h3"></a>
        <span><a name="asio.reference.file_base.requirements"></a></span><a class="link"
                                                                            href="file_base.html#asio.reference.file_base.requirements">Requirements</a>
    </h5>
    <p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">asio/file_base.hpp</code>
    </p>
    <p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
    </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%">
    <tr>
        <td align="left"></td>
        <td align="right">
            <div class="copyright-footer">Copyright © 2003-2022 Christopher M. Kohlhoff<p>
                Distributed under the Boost Software License, Version 1.0. (See accompanying
                file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
            </p>
            </div>
        </td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="experimental__wait_for_one_success/wait_for_one_success.html"><img src="../../prev.png"
                                                                                              alt="Prev"></a><a
        accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h"
                                                                                       href="../../index.html"><img
        src="../../home.png" alt="Home"></a><a accesskey="n" href="file_base/append.html"><img src="../../next.png"
                                                                                               alt="Next"></a>
</div>
</body>
</html>
